/*
 * Copyright (C) 2011 by Fabien Barbero
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flickr.api.photos.notes;

import com.flickr.api.FlickrServiceException;
import com.flickr.api.photos.Photo;
import java.awt.Rectangle;

/**
 *
 * @author Fabien Barbero
 */
public interface PhotosNotesService {
    
    /**
     * Add a note to a photo.
     * Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages.
     * @param rect                      The position of the note on the photo.
     * @param text                      The text of the note.
     * @return                          The note.
     * @throws FlickrServiceException   Error addding the note.
     */
    PhotoNote addNote(Photo photo, Rectangle rect, String text) throws FlickrServiceException;
    
    /**
     * Delete a note from a photo.
     * @param note                      The note to remove.
     * @throws FlickrServiceException   Error removing the note.
     */
    void removeNote(PhotoNote note) throws FlickrServiceException;
    
    /**
     * Edit a note on a photo.
     * Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages.
     * @param note                      The note to edit.
     * @param rect                      The position of the note on the photo.
     * @param text                      The text of the note.
     * @throws FlickrServiceException   Error editing the note.
     */
    void editNote(PhotoNote note, Rectangle rect, String text) throws FlickrServiceException;
    
}
